/*
 * (c) Copyright 2023 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.atlasdb.transaction.api.expectations;

import org.immutables.value.Value;

@Value.Immutable
public interface TransactionWriteMetadataInfo {

    /**
     * The number of {@link com.palantir.lock.watch.ChangeMetadata} objects stored internally in a transaction.
     */
    long changeMetadataBuffered();

    /**
     * The number of {@link com.palantir.lock.watch.ChangeMetadata} objects attached to cell-level {@link com.palantir.lock.LockDescriptor}s
     * when requesting commit locks.
     */
    long cellChangeMetadataSent();

    /**
     * The number of {@link com.palantir.lock.watch.ChangeMetadata} objects attached to row-level {@link com.palantir.lock.LockDescriptor}s
     * when requesting commit locks.
     */
    long rowChangeMetadataSent();
}
